home *** CD-ROM | disk | FTP | other *** search
SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((MMMMaaaayyyy 11112222,,,, 1111999999996666)))) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) NNNNAAAAMMMMEEEE sendpage - submit a pager job for transmission SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS sssseeeennnnddddppppaaaaggggeeee [ _o_p_t_i_o_n_s ] [ _m_e_s_s_a_g_e... ] DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN _s_e_n_d_p_a_g_e submits a pager transmission request to a server using the Simple Network Paging Protocol (SNPP) described in RFC 1861. Pager requests specified with _s_e_n_d_p_a_g_e are normally processed immediately, although they may also be queued for transmission at a later time using a syntax identical to the _a_t(1) command. For each job that is queued, _s_e_n_d_p_a_g_e prints a _j_o_b _i_d_e_n_t_i_f_i_e_r on the standard output. A job identifier is the token by which jobs are identified within _H_y_l_a_F_A_X. Job identifiers can be supplied to the _f_a_x_r_m(1) command to remove the jobs or to the _f_a_x_a_l_t_e_r(1) command to alter job parameters. Pages may be sent to one or more destination paging terminals and, optionally, include a text message (depending on the capability of the receiving device). Each destination is identified by a Pager Identification Number (PIN) specified with the ----pppp option; for example, sendpage -p 12345 ``Help, the fax machine is on fire!''. A PIN is typically a numeric string though it may also be an alpha- numeric alias depending on the capabilities of the SNPP server. Text messages can be specified on the command line or taken from standard input. The ----nnnn option must be used if no text message is to be supplied with the page request-as for a numeric-only pager. Text supplied to the paging system is sent exactly as submitted including any newline, carriage return, or non-ASCII data. Message preparation including filtering and formatting must be done prior to submitting the data to _s_e_n_d_p_a_g_e. Note that text supplied on the command line does not include a trailing newline character. The order of options on the command line is significant. Each page to be transmitted is assigned the current value of parameters specified on the command line; e.g. whether or not to queue the request. This means that options that specify parameters for a particular destination must precede the pager ID specified with the ----pppp option. For example, sendpage -l 2 -p sam Your network is hosed submits a page to ``sam'' that has service level 2 while sendpage -p sam -l 2 Your network is hosed Page 1 (printed 6/24/99) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((MMMMaaaayyyy 11112222,,,, 1111999999996666)))) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) submits the same page but with the default service level (1). Note also that parameter values persist across ----pppp options so the following sendpage -l 0 -p sam -p 5551212 Your network is hosed submits two pages, both of which have service level 0. OOOOPPPPTTTTIIIIOOOONNNNSSSS ----aaaa _t_i_m_e Schedule transmission at the indicated _t_i_m_e. Times are specified using the syntax of the _a_t(1) command; e.g. ``now + 30 minutes'' to schedule transmission 30 minutes in the future. By default, _s_e_n_d_p_a_g_e schedules pages for ``now''. (In SNPP parlance this option specifies the ``hold time'' for the page; and may result in the page being delivered to the paging terminal but not delivered to the user until the specified time.) ----DDDD Enable notification by electronic mail when the page has been delivered to the service provider. This option is meaningful only when communicating with a _H_y_l_a_F_A_X server. ----ffff _f_r_o_m Use _f_r_o_m as the identity of the message sender. Otherwise the sender is the user that invoked _s_e_n_d_p_a_g_e. The sender is an account name to which the _H_y_l_a_F_A_X software should direct email notification messages. The _f_r_o_m identity may be a fullblown ``From:'' line, e.g. e.g. ``Joe Blow <joe@foo.com>'' and ``joe@foo.com (Joe Blow)'' are acceptable. If no host-part is specified in the _f_r_o_m string the local hostname is used. This option is useful when _s_e_n_d_p_a_g_e is invoked on behalf of another user, such as in the implementation of an electronic mail to pager gateway. ----hhhh [_m_o_d_e_m@]_h_o_s_t[:_p_o_r_t] Force the jobs to be processed on a specific _h_o_s_t and, optionally, using a particular _m_o_d_e_m. The _h_o_s_t may be either a symbolic name or a network address. If no ----hhhh option is supplied, _s_e_n_d_p_a_g_e uses the SNPPSERVER environment variable to identify the SNPP server to which the pages should be directed. If no server is specified then _s_e_n_d_p_a_g_e attempts to contact a server on the local host. If no modem is specified, the job will be submitted to any available modem. Page 2 (printed 6/24/99) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((MMMMaaaayyyy 11112222,,,, 1111999999996666)))) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) ----IIII time If a job must be requeued because of a communication failure schedule the retry according to the specified _t_i_m_e. Times are given in seconds. Minutes, hours, and days can be specified with ``_m_i_n'', ``_h_o_u_r'', and ``_d_a_y'' suffixes, respectively. By default _H_y_l_a_F_A_X reschedules jobs using retry times that depend on the manner in which the job failed; this interface permits a user to override this algorithm and specify a single fixed retry time for all communication failures. This option is meaningful only when communicating with a _H_y_l_a_F_A_X server. ----llll level Specify a particular service _l_e_v_e_l to use in delivering a page. A service level defines both a scheduling priority and the time that a client is willing to wait to find out if delivery is successful or not. Normal delivery is obtained with level 1 (default). The specification identifies level 0 as the highest priority service level with levels 1-7 lower priority and levels 8-11 vendor/server-specific. For _H_y_l_a_F_A_X server machines the mapping between service level and scheduling priority is defined by the configuration of the SNPP server process; see the PPPPrrrriiiioooorrrriiiittttyyyyMMMMaaaapppp parameter in _h_f_a_x_d(1M) ----nnnn Send to a numeric-only paging device; i.e. do not send a text message in the paging request. ----NNNN Do not notify the sender by electronic mail when the page has been delivered to the service provider (default). This option is meaningful only when communicating with a _H_y_l_a_F_A_X server. ----pppp _P_I_N The Pager Identification Number (PIN) for a terminal that is to receive the message. A message can be sent to multiple destinations by specifiying multiple ----pppp options. ----qqqq Mark pages to be queued on the server and do not wait for their delivery. By default _s_e_n_d_p_a_g_e conforms to the SNPP spec by synchronously waiting for each page to be delivered. This option instructs _s_e_n_d_p_a_g_e to submit one or pages and then terminate immediately without waiting for their completion. When pages are queued it is advisable to enable email notification with the ----DDDD or ----RRRR options. Job queueing is a non- standard function of the SNPP implementation in _H_y_l_a_F_A_X and is not available when submitting Page 3 (printed 6/24/99) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((MMMMaaaayyyy 11112222,,,, 1111999999996666)))) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) pages to non-_H_y_l_a_F_A_X servers. ----RRRR Enable notification by electronic mail when the message has been delivered and when it is requeued for retransmission. _H_y_l_a_F_A_X will always notify the sender by electronic mail if there is problem delivering a page (irregardless of the email notification setting). This option is meaningful only when communicating with a _H_y_l_a_F_A_X server. ----ssss _s_u_b_j_e_c_t Set the ``subject'' for the specified pages according to _s_u_b_j_e_c_t. For _H_y_l_a_F_A_X _s_u_b_j_e_c_t is used as the identifier string returned in any email notification messages (instead of the usual job identifier number). This option is useful for applications that cross reference notification messages against job submissions. ----tttt _t_r_i_e_s Make no more than _t_r_i_e_s attempts to send the page. By default, _H_y_l_a_F_A_X will terminate a job if: 3 consecutive attempts to send a particular message fail, or it appears the receiver is not a service provider. Otherwise _H_y_l_a_F_A_X places no limit on the _n_u_m_b_e_r of attempts to send a page, instead terminating a job if it is not completed within a fixed period of time specified by the service level. Note that a try is a phone call in which carrier is established and the IXO/TAP or UCP protocol is commenced; this is contrasted with a call attempt that might have failed because the line was busy. This option is meaningful only when communicating with a _H_y_l_a_F_A_X server. ----TTTT _d_i_a_l_s Make no more than _d_i_a_l_s phone calls when attempting to send a page. By default, _H_y_l_a_F_A_X will terminate a job if: 12 attempts to reach a service provider fail, or it appears the receiver is not a service provider. Otherwise _H_y_l_a_F_A_X terminates a job if it is not completed within a fixed period of time specified by the _s_e_r_v_i_c_e _l_e_v_e_l. This option is meaningful only when communicating with a _H_y_l_a_F_A_X server. ----vvvv Trace the protocol between _s_e_n_d_p_a_g_e and the SNPP server process that does the delivery work on the remote machine. This information is directed to the standard output. CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS _s_e_n_d_p_a_g_e reads configuration information from the files Page 4 (printed 6/24/99) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((MMMMaaaayyyy 11112222,,,, 1111999999996666)))) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) ////uuuussssrrrr////ffffrrrreeeeeeeewwwwaaaarrrreeee////lllliiiibbbb////ffffaaaaxxxx////hhhhyyyyllllaaaa....ccccoooonnnnffff, ////uuuussssrrrr////ffffrrrreeeeeeeewwwwaaaarrrreeee////lllliiiibbbb////ffffaaaaxxxx////sssseeeennnnddddppppaaaaggggeeee....ccccoooonnnnffff, and ~~~~////....hhhhyyyyllllaaaarrrrcccc; in that order. Configuration files follow the conventions described in _h_y_l_a_f_a_x(1). The following configuration parameters are recognized: TTTTaaaagggg TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn HoldTime string - hold time to assign to pages Host string localhost host to contact for service MailAddr string - mail address for notification messages MaxDials integer 12 times to retry dialing MaxTries integer 3 times to retry transmission Notify string none control email notification Port integer 444 port to use in contacting server Protocol string tcp protocol to use in contacting server QueueSend boolean No whether or not to queue pages RetryTime string - delay between failed attempts to send ServiceLevel integer SNPP service level for pages Verbose boolean No whether or not to enable protocol tracing The configuration parameters are explained below: HHHHoooollllddddTTTTiiiimmmmeeee The hold time to assign to pages. (Equivalent to the ----aaaa option.) HHHHoooosssstttt The host to contact for service. (Equivalent to the ----hhhh option.) MMMMaaaaiiiillllAAAAddddddddrrrr The electronic mail address to direct notification messages from the server. If this string is specified without an ``@hostname'' part then the local hostname will automatically be appended. (Equivalent to the ----ffff option.) MMMMaaaaxxxxDDDDiiiiaaaallllssss The maximum number of times to dial the phone for each job. (Equivalent to the ----TTTT option.) MMMMaaaaxxxxTTTTrrrriiiieeeessss The maximum number of times to retry sending a job. (Equivalent to the ----tttt option.) NNNNoooottttiiiiffffyyyy Control the email notification messages from the server. This string may be one of ``done'', ``none'', ``requeued'' or ``default'' with an optionally preceding ``when '' (e.g. ``when done''). Note that ``when requeued'' implies ``when done''. (Equivalent to the ----DDDD, ----RRRR, and ----NNNN options.) PPPPoooorrrrtttt The network port to contact for service. (Eqvuialent to the ----hhhh option.) Page 5 (printed 6/24/99) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((MMMMaaaayyyy 11112222,,,, 1111999999996666)))) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) PPPPrrrroooottttooooccccoooollll The name of the communication protocol to use when contacting a server. (Equivalent to the SSSSNNNNPPPPPPPPSSSSEEEERRRRVVVVIIIICCCCEEEE environment variable.) QQQQuuuueeeeuuuueeeeSSSSeeeennnndddd Control whether or not to wait for the pages to be delivered. (Equivalent to the ----qqqq option.) RRRReeeettttrrrryyyyTTTTiiiimmmmeeee The time to delay between job retries due to a communication failure. (Equivalent to the ----IIII option.) SSSSeeeerrrrvvvviiiicccceeeeLLLLeeeevvvveeeellll The SNPP service level to assign to each page. (Equivalent to the ----llll option.) VVVVeeeerrrrbbbboooosssseeee Control protocol tracing. (Equivalent to the ----vvvv option.) EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT The following environment variables are used by _s_e_n_d_p_a_g_e: SSSSNNNNPPPPPPPPSSSSEEEERRRRVVVVEEEERRRR The identity of the SNPP server to contact for service. This value is specified as ``[_m_o_d_e_m@]_h_o_s_t[:_p_o_r_t]'' where _h_o_s_t is either a host name or the Internet ``.'' (dot) address of the host; _p_o_r_t is the TCP port number or service name to use (default is ``snpp'' or 444); and _m_o_d_e_m is an optional modem name or class on the server machine to use in processing the requests (this is meaningful only when the server is running _H_y_l_a_F_A_X). SSSSNNNNPPPPPPPPSSSSEEEERRRRVVVVIIIICCCCEEEE The communication service specification for communicating with the SNPP server. This value is specified as ``_p_o_r_t[/_p_r_o_t_o_c_o_l]''; by default ``444/tcp''. FFFFIIIILLLLEEEESSSS /usr/tmp/sndpageXXXXXX temporary files NNNNOOOOTTTTEEEESSSS The phone number of the pager service provider is stored on the server machine and is not specified by the user; this is a departure from pager support that was supplied with _H_y_l_a_F_A_X version 3.0. _H_y_l_a_F_A_X version 3.0 used to recognize a null text message and assume the destination paging device was numeric-only. This is no longer true; if a null text message is submitted then a null message will be included in the paging request. This may cause paging requests submitted to ``real SNPP'' Page 6 (printed 6/24/99) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((MMMMaaaayyyy 11112222,,,, 1111999999996666)))) SSSSEEEENNNNDDDDPPPPAAAAGGGGEEEE((((1111)))) servers to be rejected if the paging device is in fact numeric-only. When sending to a numeric-only paging device the ----nnnn option should be used. BBBBUUUUGGGGSSSS It is not possible to page text- and non-text devices together; _s_e_n_d_p_a_g_e must be run twice, once to send to text- capable devices and once to send to non-text devices. SSSSEEEEEEEE AAAALLLLSSSSOOOO _a_t(1), _h_y_l_a_f_a_x(1), _f_a_x_a_l_t_e_r(1), _f_a_x_r_m(1), _f_a_x_s_t_a_t(1), _f_a_x_q(1M), _h_f_a_x_d(1M), _h_y_l_a_f_a_x(4F) Page 7 (printed 6/24/99) 
